home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / text / hyper / checkguide / checkguide.doc < prev    next >
Encoding:
Text File  |  1996-09-07  |  1.8 KB  |  48 lines
  1.  
  2.           CheckGuide 1.0 -- Checks AmigaGuide files for common errors
  3.  
  4.              by Eddy Carroll, September 1994. Freely distributable.
  5.  
  6. INTRODUCTION
  7.  
  8.     If you've ever tried creating even a modestly sized AmigaGuide file
  9.     by hand, you'll have discovered that it can be quite difficult to
  10.     keep track of all the various links and cross references. As your
  11.     help file gets larger, it gets increasingly harder to ensure that
  12.     you have remembered to reference all the nodes in the file from at
  13.     least one place, and haven't left any unresolved links.
  14.  
  15.     CheckGuide is a simple utility that can detect several common errors
  16.     in AmigaGuide files. The errors it can detect are:
  17.  
  18.      o  Extra plain text between an @ENDNODE and @NODE (AmigaGuide won't
  19.         allow such text to ever be displayed)
  20.  
  21.      o  Nodes that are defined but not referenced from any other node.
  22.         Unless your program directly instructs AmigaGuide to access such
  23.         nodes, the user won't easily be able to access them.
  24.  
  25.      o  Links to help nodes that aren't defined within the file.
  26.  
  27.      o  Open braces with no preceding @ character (usually a simple typo).
  28.  
  29.      o  @{" Button "} constructs with no LINK command (an easy mistake to
  30.         make if you're entering a lot of them).
  31.  
  32.     All of these options can be selectively enabled or disabled.
  33.  
  34.  
  35. USAGE
  36.  
  37.     The command template looks like this:
  38.  
  39.         CheckGuide filename.guide [Options]
  40.  
  41.     Filename.guide is the AmigaGuide file you wish to check. The .guide
  42.     suffix is optional; CheckGuide will add it if necessary. The valid
  43.     options are:
  44.  
  45.         EXTRATEXT  Check for extra text between @ENDNODE and @NODE
  46.             NODES  Check for nodes that are not referenced anywhere
  47.              REFS  Check for references to non-existant nodes
  48.            BRACES  Check fo